'\" te
.\" Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved.
.\" Copyright (c) 2015, Joyent, Inc. All Rights Reserved.
.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
.\"  See the License for the specific language governing permissions and limitations under the License. When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with
.\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
.TH SYSEVENT_GET_VENDOR_NAME 3SYSEVENT "Jun 29, 2015"
.SH NAME
sysevent_get_vendor_name, sysevent_get_pub_name, sysevent_get_pid \- get vendor
name, publisher name or processor ID of event
.SH SYNOPSIS
.LP
.nf
\fBcc \fR [\fIflag \&.\|.\|.\fR]  \fIfile\fR\&.\|.\|. \fB-lsysevent\fR [\fIlibrary \&.\|.\|.\fR]
#include <libsysevent.h>

\fBchar *\fR\fBsysevent_get_vendor_name\fR(\fBsysevent_t *\fR\fIev\fR);
.fi

.LP
.nf
\fBchar *\fR\fBsysevent_get_pub_name\fR(\fBsysevent_t *\fR\fIev\fR);
.fi

.LP
.nf
\fBvoid\fR \fBsysevent_get_pid\fR(\fBsysevent_t *\fR\fIev\fR, \fBpid_t *\fR\fIpid\fR);
.fi

.SH PARAMETERS
.ne 2
.na
\fB\fIev\fR\fR
.ad
.RS 6n
handle to a system event object
.RE

.SH DESCRIPTION
.LP
The \fBsysevent_get_pub_name()\fR function returns the publisher name for the
sysevent handle, \fIev\fR.  The publisher name identifies the name of the
publishing application or kernel subsystem of the sysevent.
.sp
.LP
The \fBsysevent_get_pid()\fR function sets the process ID \fIpid\fR to that of
the publishing application or \fBSE_KERN_PID\fR for sysevents originating in the
kernel. The publisher name and PID are useful for implementing event
acknowledgement.
.sp
.LP
The \fBsysevent_get_vendor_name()\fR function returns the vendor string for the
publishing application or kernel subsystem.  A vendor string is the company's
stock symbol that provided the application or kernel subsystem that generated
the system event.  This information is useful for filtering sysevents for one
or more vendors.
.sp
.LP
The interface manages the allocation of the vendor and publisher name strings,
but it is the caller's responsibility to free the strings when they are no
longer needed by calling \fBfree\fR(3MALLOC). If the new vendor and publisher
name strings cannot be created, \fBsysevent_get_vendor_name()\fR and
\fBsysevent_get_pub_name()\fR return a null pointer and may set errno to
\fBENOMEM\fR to indicate that the storage space available is insufficient.
.SH EXAMPLES
.LP
\fBExample 1 \fRParse sysevent header information.
.sp
.LP
The following example parses sysevent header information from an application's
event handler.

.sp
.in +2
.nf
char *vendor;
char *pub;
pid_t pid;

void
event_handler(sysevent_t *ev)
{
        if (strcmp(EC_PRIV, sysevent_get_class_name(ev)) != 0) {
                return;
        }

        vendor = sysevent_get_vendor_name(ev);
        if (strcmp("SUNW", vendor) != 0) {
                free(vendor);
                return;
        }
        pub = sysevent_get_pub_name(ev);
        if (strcmp("test_daemon", pub) != 0) {
                free(vendor);
                free(pub);
                return;
        }
        sysevent_get_pid(ev, &pid);
        (void) kill(pid, SIGUSR1);

        free(vendor);
        free(pub);
}
.fi
.in -2

.SH ATTRIBUTES
.LP
See \fBattributes\fR(7) for descriptions of the following attributes:
.sp

.sp
.TS
box;
c | c
l | l .
ATTRIBUTE TYPE	ATTRIBUTE VALUE
_
Interface Stability	Committed
_
MT-Level	MT-Safe
.TE

.SH SEE ALSO
.LP
.BR malloc (3MALLOC),
.BR attributes (7)
.SH NOTES
.LP
The \fBlibsysevent\fR interfaces do not work at all in non-global zones.
